highlights 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fcea1731a6628ecb00dbc6b494a293063e34acaf08bb9606a9ba3fed874146b
-  data.tar.gz: fb981259fcb198c412fef78b5b0a022328513e70fe9aff5aa0a743491f19e133
+  metadata.gz: 832f4ea3a552923f9c87fe91567aeee0180005e58938537d252bf68385c3a24a
+  data.tar.gz: 54fb8e68ac68bad41d5b34ffa114ac1399e3b3c24a859666da6e326b76e7c5f3
 SHA512:
-  metadata.gz: aeee1c45284bbfe64b6c933d0e66e407de65fd88ded8cbedaa22c95589622446d551a64a887dbbf8e5dc1a36bafe85443705bd30ce042d980c7e8540ec9d3705
-  data.tar.gz: 9f0de9d7738dc8d1c7dea24acd865b9174c2cd12204b83b6243b8762d8e7f9bfcf5a0b4999b0afdd79c9771e3ee54aa98d37f5b47bcb6c693007f5492b7397b8
+  metadata.gz: 62e516c81fa1961155219428448e4053d31fa92c2e0825a598adf18d91494926cba856a9c5e4fad6c09809b772286a92ba1ca7de725d9f205c9023e62d627455
+  data.tar.gz: fe6bd2fbb6e83f440dc6456bce5471564f62841a6f29ff5b3a2bdd513bd91a959d9dabd0b25cbfe5f4b8a71894a6080795cc2c3342cd441e912012d03d7ece28

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    highlights (0.1.0)
+    highlights (1.0.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,28 +1,52 @@
 # 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.
+A CLI that converts Kindle CSV documents to Markdown.
 
-TODO: Delete this and the text above, and describe your gem
+## Example
 
-## Installation
+```
+$ highlights -f zamm_notes.csv -o zamm_notes.md
+$ head zamm_notes.md
+```
 
-Add this line to your application's Gemfile:
+Outputs:
 
-```ruby
-gem 'highlights'
 ```
+# ZEN AND THE ART OF MOTORCYCLE MAINTENANCE: AN INQUIRY INTO VALUES
+## by Robert M. Pirsig
+
+### Notes
 
-And then execute:
+> You�re a passive observer and it is all moving by you boringly in a frame.
 
-    $ bundle install
+Highlight (Yellow): Page 4
 
-Or install it yourself as:
+> Instead you spend your time being aware of things and meditating on them. On sights and sounds, on the mood of the weather and things remembered, on the machine and the countryside you�re in, thinking about things at great leisure and length without being hurried and without feeling you�re losing time.
+
+Highlight (Yellow): Page 6
+```
+
+## Installation
 
-    $ gem install highlights
+```
+$ gem install highlights
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+$ highlights -f zamm_notes.csv
+```
+
+```
+$ highlights -h
+
+Usage: highlights [options]
+    -f, --file=FILENAME              Kindle notes CSV file
+    -o, --output=OUTPUT              Output file (default: notes.md)
+    -h, --help                       Show help
+    -v, --version                    Show version
+```
 
 ## Development
 
@@ -32,7 +56,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/highlights.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mgmarlow/highlights.
 
 
 ## License

data/exe/highlights

@@ -2,6 +2,7 @@
 
 require "bundler/setup"
 require "highlights"
+require "highlights/cli"
 
 Highlights::CLI.new(ARGV).run
 

data/lib/highlights.rb

@@ -1,93 +1,12 @@
-require "highlights/version"
 require "csv"
 require "optparse"
 
+require "highlights/error"
+require "highlights/version"
+require "highlights/parser"
+require "highlights/renderer"
+
 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/cli.rb

@@ -0,0 +1,41 @@
+module Highlights
+  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 (default: notes.md)") 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/error.rb

@@ -0,0 +1,4 @@
+module Highlights
+  class Error < StandardError
+  end
+end

data/lib/highlights/parser.rb

@@ -0,0 +1,22 @@
+module Highlights
+  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
+end

data/lib/highlights/renderer.rb

@@ -0,0 +1,25 @@
+module Highlights
+  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.write("\n")
+        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
+end

data/lib/highlights/version.rb

@@ -1,3 +1,3 @@
 module Highlights
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: highlights
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Graham Marlow
@@ -29,6 +29,10 @@ files:
 - exe/highlights
 - highlights.gemspec
 - lib/highlights.rb
+- lib/highlights/cli.rb
+- lib/highlights/error.rb
+- lib/highlights/parser.rb
+- lib/highlights/renderer.rb
 - lib/highlights/version.rb
 homepage: https://github.com/mgmarlow/highlights
 licenses: