highlights 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2f5c225843527c05097f6994730cfe7f9ba1ebfafb5381dd46d853269e29f9b
+  data.tar.gz: 2667c9be6107490ca8fab2406917c5d8b44e1dc0168bf5aaf5e2fac9b0e1ca68
+SHA512:
+  metadata.gz: dca87c203d656b54c1c0fc31653a95bfe8179e284f7bafb321d63d3dcce523d439bc06079ba55f318cf36c36f9d270bf953903c9fc3291780eff1a8a3a4f82e4
+  data.tar.gz: 128dd5672ec4e649bc748ca7c580e09f6e07f557e2cf3d6ee07bf146c57e996c27532fe58060ac5e56004db56d8af3bb4e1b44f8aef92d5b593d22cb937e3992

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.csv
+notes.md

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in highlights.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    highlights (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.3)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  highlights!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Graham Marlow
+
+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,40 @@
+# Highlights
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/highlights`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'highlights'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install highlights
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/highlights.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "highlights"
+
+# 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/exe/highlights

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "highlights"
+
+Highlights::CLI.new(ARGV).run
+

data/highlights.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/highlights/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "highlights"
+  spec.version       = Highlights::VERSION
+  spec.authors       = ["Graham Marlow"]
+  spec.email         = ["mgmarlow@hey.com"]
+
+  spec.summary       = "A readable format for Kindle notes."
+  spec.homepage      = "https://github.com/mgmarlow/highlights"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mgmarlow/highlights"
+  spec.metadata["changelog_uri"] = "https://github.com/mgmarlow/highlights/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/lib/highlights.rb

@@ -0,0 +1,93 @@
+require "highlights/version"
+require "csv"
+require "optparse"
+
+module Highlights
+  class Error < StandardError; end
+  Note = Struct.new(:type, :location, :starred, :annotation)
+  Document = Struct.new(:title, :author, :notes)
+
+  class Renderer
+    def initialize(document, outfile)
+      @document = document
+      @outfile = outfile
+    end
+
+    def render
+      File.open(@outfile, 'w') do |file|
+        file.puts("# #{@document.title}")
+        file.puts("## #{@document.author}")
+        file.puts("### Notes")
+        file.write("\n")
+
+        @document.notes.each do |note|
+          file.puts("> #{note.annotation}")
+          file.write("\n")
+          file.puts("#{note.type}: #{note.location}")
+          file.write("\n")
+        end
+      end
+    end
+  end
+
+  class Parser
+    class MalformedCSVError < Error; end
+    NOTES_STARTING_POSITION = 8
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def parse
+      table = CSV.read(@filename, liberal_parsing: true)
+
+      notes = table[NOTES_STARTING_POSITION...].map do |note_row|
+        Note.new(*note_row)
+      end
+
+      Document.new(table[1][0], table[2][0], notes)
+    rescue StandardError => e
+      raise MalformedCSVError.new(e.message)
+    end
+  end
+
+  class CLI
+    Options = Struct.new(:filename, :output)
+
+    def initialize(args)
+      @args = args
+    end
+
+    def run
+      options = get_options
+      document = Parser.new(options.filename).parse
+      Renderer.new(document, options.output).render
+    end
+
+    def get_options
+      options = Options.new(nil, "notes.md")
+
+      OptionParser.new do |opts|
+        opts.on("-fFILENAME", "--file=FILENAME", "Kindle notes CSV file") do |f|
+          options.filename = f
+        end
+
+        opts.on("-oOUTPUT", "--output=OUTPUT", "Output file") do |o|
+          options.output = o
+        end
+
+        opts.on("-h", "--help", "Show help") do
+          puts opts
+          exit
+        end
+
+        opts.on("-v", "--version", "Show version") do
+          puts VERSION
+          exit
+        end
+      end.parse!(@args)
+
+      options
+    end
+  end
+end

data/lib/highlights/version.rb

@@ -0,0 +1,3 @@
+module Highlights
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: highlights
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Graham Marlow
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-22 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- mgmarlow@hey.com
+executables:
+- highlights
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/highlights
+- highlights.gemspec
+- lib/highlights.rb
+- lib/highlights/version.rb
+homepage: https://github.com/mgmarlow/highlights
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mgmarlow/highlights
+  source_code_uri: https://github.com/mgmarlow/highlights
+  changelog_uri: https://github.com/mgmarlow/highlights/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A readable format for Kindle notes.
+test_files: []