clippings_pluck 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c580728b35727180d4f14814ae842a207ff0771
+  data.tar.gz: 4d68827fcf34987d3734d3580737132e919021ce
+SHA512:
+  metadata.gz: 8599cccebcc2c241147bda84eb0553d5673d1c9875c0e72134e147afe332d7700c24b534453798da28bdb978603113371447f6b00148cf2836f5f29d1f242e99
+  data.tar.gz: 63f8278f57fc056e3cad2a52df8543c59e04a604e77909c8de7d5a00ee90f2d7fd1a34c0a6da7bbd45f5e438ddb7a3d9bf6334ccfab85d0ea01ed3ff785292e0

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jgplane@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clippings_pluck.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jack Plane
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# ClippingsPluck
+
+Amazon stores all of your kindle highlights and notes in a txt file called "My Clippings.txt".
+Amazon will also let you export those highlights as a CSV file.
+ClippingsPluck accepts a string read from one of those files and returns an array of hashes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clippings_pluck'
+```
+
+And then execute:
+
+    $ bundle
+
+## ClippingsPluck::CsvParser Usage
+
+_Note:_ this is the preferred way to interact with ClippingsPluck. The Kindle CSV file is
+much more reliable and straightforward to parse than the TXT file.
+
+First, read from the csv file:
+```ruby
+string = File.open("clippings.csv", "rb").read
+```
+
+Then, you can pass that string into ClippingsPluck like this:
+
+```ruby
+ClippingsPluck::CsvParser.new.run(string)
+```
+
+You'll get back an array of hashes, each of which might look something like this:
+
+```ruby
+{
+  note: nil,
+  quote: '"He was not no machine!" screamed Gloria, fiercely and ungrammatically.',
+  author: "Isaac Asimov",
+  book_title: "I, Robot (The Robot Series Book 1)",
+  page: nil,
+  location: "245",
+  date: nil
+}
+```
+
+## ClippingsPluck::TxtParser Usage
+
+Using the TXT file parser is similar:
+
+```ruby
+file = File.open("./My\ Clippings.txt", "rb")
+contents = file.read
+```
+
+Then, you can feed the string to ClippingsPluck like this:
+
+```ruby
+ClippingsPluck::TxtParser.new.run(contents)
+```
+
+You'll get back an array of hashes, each of which might look something like this:
+
+```ruby
+{
+  note: nil,
+  quote: '"He was not no machine!" screamed Gloria, fiercely and ungrammatically.',
+  author: "Isaac Asimov",
+  book_title: "I, Robot (The Robot Series Book 1)",
+  page: nil,
+  location: "245",
+  date: "Tuesday, November 22, 2017 6:42:51 PM"
+}
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clippings_pluck"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clippings_pluck.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clippings_pluck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clippings_pluck"
+  spec.version       = ClippingsPluck::VERSION
+  spec.authors       = ["Jack Plane"]
+  spec.email         = ["jgplane@gmail.com"]
+
+  spec.summary       = "Kindle Clippings file parser"
+  spec.description   = "https://github.com/jgplane/clippings-pluck"
+  spec.homepage      = "https://github.com/jgplane/clippings-pluck"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/clippings_pluck.rb

@@ -0,0 +1,9 @@
+require "clippings_pluck/version"
+
+require_relative "clippings_pluck/clippings"
+require_relative "clippings_pluck/clipping"
+require_relative "clippings_pluck/location"
+require_relative "clippings_pluck/txt_parser"
+require_relative "clippings_pluck/csv_parser"
+
+module ClippingsPluck; end

data/lib/clippings_pluck/clipping.rb

@@ -0,0 +1,27 @@
+module ClippingsPluck
+  class Clipping < Hash
+    def location=(location)
+      self[:location] = Location.new(location)
+    end
+
+    def normalized_location
+      missing_location? ? nil : self[:location].normalize
+    end
+
+    def eligible_for_note_attachment?(note_location)
+      has_location? && normalized_location <= note_location
+    end
+
+    def notated?
+      !self[:note].nil?
+    end
+
+    def missing_location?
+      self[:location].nil?
+    end
+
+    def has_location?
+      !missing_location?
+    end
+  end
+end

data/lib/clippings_pluck/clippings.rb

@@ -0,0 +1,25 @@
+module ClippingsPluck
+  class Clippings < Array
+    def closest_highlight(note_location)
+      sorted_eligible_note_matches(note_location.normalize).last
+    end
+
+    def with_notes
+      select(&:notated?)
+    end
+
+    def without_notes
+      self - with_notes
+    end
+
+    private
+
+    def sorted_eligible_note_matches(location)
+      eligible_note_matches(location).sort_by(&:normalized_location)
+    end
+
+    def eligible_note_matches(location)
+      select { |clipping| clipping.eligible_for_note_attachment?(location) }
+    end
+  end
+end

data/lib/clippings_pluck/csv_parser.rb

@@ -0,0 +1,81 @@
+require 'csv'
+
+module ClippingsPluck
+  class CsvParser
+    EXCEL_DIVIDER = "----------------------------------------------\t\t\t\r\t\t\t\r"
+    EXCEL_SEP = "\t"
+
+    AMZN_DIVIDER = "----------------------------------------------"
+    AMZN_SEP = ","
+
+    def initialize
+      @clippings = Clippings.new
+    end
+
+    def run(string)
+      @string = string
+      @raw_metadata, @clipping_data = @string.split(divider)
+      @book, @authors = parse_metadata
+      build_clippings
+      @clippings
+    end
+
+    private
+
+    def excel?
+      @string.include? EXCEL_DIVIDER
+    end
+
+    def divider
+      excel? ? EXCEL_DIVIDER : AMZN_DIVIDER
+    end
+
+    def sep
+      excel? ? EXCEL_SEP : AMZN_SEP
+    end
+
+    def parse_metadata
+      metadata = @raw_metadata.split("\r")[1..2].map(&:strip).map{ |line| line.gsub(/by /, "") }
+      metadata.map! { |string| string.gsub("\"", "").gsub(",,,", "") } if !excel?
+      metadata
+    end
+
+    def build_clippings
+      remove_ghost_rows if !excel?
+      csv_hash = CSV.parse(@clipping_data, headers: true, col_sep: sep).map(&:to_h)
+      csv_hash.each { |data| format_according_to_type(data) }
+    end
+
+    def remove_ghost_rows
+      @clipping_data = @clipping_data.gsub(",,,\r\n,,,\r\n", "")
+    end
+
+    def format_according_to_type(data)
+      if data['Annotation Type'] == 'Note'
+        attach_note(data)
+      else
+        @clipping = Clipping.new
+        @clippings << format_clipping(data)
+      end
+    end
+
+    def attach_note(data)
+      if @clippings.last[:note].empty?
+        @clippings.last[:note] = data['Annotation']
+      else
+        @clippings.last[:note] += " | #{data['Annotation']}"
+      end
+    end
+
+    def format_clipping(data)
+      @clipping[:quote] = data.delete 'Annotation'
+      @clipping.location = (data.delete 'Location').gsub(/Location /, '')
+      @clipping[:note] = ""
+      @clipping[:book_title] = @book
+      @clipping[:author] = @authors
+      data.delete 'Annotation Type'
+      data.delete 'Starred?'
+      @clipping
+    end
+  end
+end

data/lib/clippings_pluck/location.rb

@@ -0,0 +1,18 @@
+module ClippingsPluck
+  class Location < String
+    def normalize
+      range? ? highest_of_range : self
+    end
+
+    private
+
+    def range?
+      include?("-")
+    end
+
+    def highest_of_range
+      split("-").last
+    end
+  end
+end
+

data/lib/clippings_pluck/txt_parser.rb

@@ -0,0 +1,88 @@
+module ClippingsPluck
+  class TxtParser
+    def initialize
+      @clippings = Clippings.new
+      @clipping = Clipping.new
+    end
+
+    def run(file_content)
+      split_clippings(file_content)
+      @clippings
+    end
+
+    private
+
+    def split_clippings(file_content)
+      clippings = file_content.force_encoding("UTF-8").split("=" * 10).delete_if { |c| c.strip.empty? }
+      clippings.each { |clipping| parse_lines(clipping) }
+    end
+
+    def parse_lines(clipping)
+      lines = clipping.lines.delete_if { |line| line.strip.empty? }.collect(&:strip)
+      parse_type(lines) if lines.length == 3
+    end
+
+    def parse_type(lines)
+      parse_quote(lines) if lines[1].include? "Highlight"
+      parse_note(lines) if lines[1].include? "Note"
+    end
+
+    def parse_note(lines)
+      if @clippings.length.positive?
+        location = Location.new(find_location(lines))
+        highlight = @clippings.closest_highlight(location)
+        highlight[:note] = lines[2]
+      end
+    end
+
+    def parse_quote(lines)
+      @clipping[:note] = nil
+      @clipping[:quote] = lines[2]
+      parse_author(lines)
+    end
+
+    def parse_author(lines)
+      author_names = lines[0].reverse[/\).*?\(/].to_s.gsub(/[()]/, "").reverse
+      if author_names.include? ","
+        last_name, first_name = author_names.split(",").collect(&:strip)
+      else
+        first_name, last_name = author_names.split(" ", 2).collect(&:strip)
+      end
+      @clipping[:author] = first_name + ' ' + last_name
+      lines[0].slice!("(#{author_names})")
+      parse_book(lines)
+    end
+
+    def parse_book(lines)
+      @clipping[:book_title] = lines[0].strip
+      parse_page(lines)
+    end
+
+    def parse_page(lines)
+      page = lines[1].match(/(?<=page ).\d*/)
+      @clipping[:page] = page.nil? ? nil : page[0].to_i
+      parse_location(lines)
+    end
+
+    def parse_location(lines)
+      @clipping.location = find_location(lines)
+      parse_date(lines)
+    end
+
+    def find_location(lines)
+      location = lines[1].match(/(?<=Location ).\S*/)
+      location.nil? ? nil : location[0].to_s
+    end
+
+    def parse_date(lines)
+      date = lines[1].match(/(?<=Added on ).+/)
+      @clipping[:date] = date.nil? ? nil : date[0]
+      push_clipping
+    end
+
+    def push_clipping
+      @clippings << @clipping
+      @clipping = Clipping.new
+    end
+  end
+end

data/lib/clippings_pluck/version.rb

@@ -0,0 +1,3 @@
+module ClippingsPluck
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: clippings_pluck
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jack Plane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: https://github.com/jgplane/clippings-pluck
+email:
+- jgplane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clippings_pluck.gemspec
+- lib/clippings_pluck.rb
+- lib/clippings_pluck/clipping.rb
+- lib/clippings_pluck/clippings.rb
+- lib/clippings_pluck/csv_parser.rb
+- lib/clippings_pluck/location.rb
+- lib/clippings_pluck/txt_parser.rb
+- lib/clippings_pluck/version.rb
+homepage: https://github.com/jgplane/clippings-pluck
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Kindle Clippings file parser
+test_files: []