highlights 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 832f4ea3a552923f9c87fe91567aeee0180005e58938537d252bf68385c3a24a
-  data.tar.gz: 54fb8e68ac68bad41d5b34ffa114ac1399e3b3c24a859666da6e326b76e7c5f3
+  metadata.gz: b830065be619ca7e81760e4a73e69301dc252a78842ecf7c610d039eff09b047
+  data.tar.gz: a2bffd6eef6483a0a7e6c59b6d92ab91613b0c5e0a6b2a201ba4c76267f52e98
 SHA512:
-  metadata.gz: 62e516c81fa1961155219428448e4053d31fa92c2e0825a598adf18d91494926cba856a9c5e4fad6c09809b772286a92ba1ca7de725d9f205c9023e62d627455
-  data.tar.gz: fe6bd2fbb6e83f440dc6456bce5471564f62841a6f29ff5b3a2bdd513bd91a959d9dabd0b25cbfe5f4b8a71894a6080795cc2c3342cd441e912012d03d7ece28
+  metadata.gz: 1bc4ca0e237b017c2abd0d0fd2b3912aa9b59012dd6dcda7449e7ce4635a3080ccdc430e6f074cae419a61fbfc63665b9b1cc515b5d5aaaf0bee6d78cfb72884
+  data.tar.gz: 600de72f3bcc2cbaa05293280d58913099af1596878b2d8116f70178e1cc28643c8cf10da58eda838f27a843889bdd042d6bc1af0aa1b1336b7c443ac0579e7c

data/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 *.csv
 notes.md
+notes.html

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,6 @@
 # Highlights
 
-A CLI that converts Kindle CSV documents to Markdown.
+A CLI that converts Kindle CSV documents to Markdown or HTML.
 
 ## Example
 
@@ -13,15 +13,16 @@ Outputs:
 
 ```
 # ZEN AND THE ART OF MOTORCYCLE MAINTENANCE: AN INQUIRY INTO VALUES
-## by Robert M. Pirsig
 
-### Notes
+by Robert M. Pirsig
 
-> You�re a passive observer and it is all moving by you boringly in a frame.
+## Notes
+
+> You�re a passive observer and it is all moving by you boringly in a frame.
 
 Highlight (Yellow): Page 4
 
-> 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.
+> 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
 ```
@@ -41,9 +42,9 @@ $ highlights -f zamm_notes.csv
 ```
 $ highlights -h
 
-Usage: highlights [options]
+Usage: highlights -f file.csv -o [output file]
     -f, --file=FILENAME              Kindle notes CSV file
-    -o, --output=OUTPUT              Output file (default: notes.md)
+    -o, --output=OUTPUT              Output file. Accepts HTML and markdown (default: notes.md)
     -h, --help                       Show help
     -v, --version                    Show version
 ```
@@ -58,7 +59,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mgmarlow/highlights.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/highlights.rb

@@ -1,9 +1,12 @@
 require "csv"
+require "erb"
 require "optparse"
 
 require "highlights/error"
 require "highlights/version"
 require "highlights/parser"
+require "highlights/formatter/markdown"
+require "highlights/formatter/html"
 require "highlights/renderer"
 
 module Highlights

data/lib/highlights/cli.rb

@@ -3,24 +3,27 @@ module Highlights
     Options = Struct.new(:filename, :output)
 
     def initialize(args)
+      args << '-h' if ARGV.empty?
       @args = args
     end
 
     def run
       options = get_options
       document = Parser.new(options.filename).parse
-      Renderer.new(document, options.output).render
+      Renderer.render(document, options.output)
     end
 
     def get_options
       options = Options.new(nil, "notes.md")
 
       OptionParser.new do |opts|
+        opts.banner = "Usage: highlights -f file.csv -o [output file]"
+
         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|
+        opts.on("-oOUTPUT", "--output=OUTPUT", "Output file. Accepts HTML and markdown (default: notes.md)") do |o|
           options.output = o
         end
 

data/lib/highlights/formatter/html.rb

@@ -0,0 +1,15 @@
+module Highlights
+  module Formatter
+    module HTML
+      def render_html
+        file = File.join(File.dirname(__FILE__), "./template.html.erb")
+        template = File.read(file)
+
+        File.open(@outfile, 'w') do |file|
+          file.write(ERB.new(template).result(binding))
+        end
+      end
+    end
+  end
+end
+

data/lib/highlights/formatter/markdown.rb

@@ -0,0 +1,23 @@
+module Highlights
+  module Formatter
+    module Markdown
+      def render_markdown
+        File.open(@outfile, 'w') do |file|
+          file.puts("# #{@document.title}")
+          file.write("\n")
+          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
+end

data/lib/highlights/formatter/template.html.erb

@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title><%= @document.title %></title>
+  <style>
+    body {
+      width: calc(100% - 40px);
+      max-width: 675px;
+      margin: 0 auto;
+    }
+
+    body, * {
+      font-family: Georgia, serif;
+    }
+
+    p {
+      font-size: 18px;
+      line-height: 1.45;
+    }
+
+    ul {
+      margin: 0;
+      padding: 0;
+      list-style: none;
+    }
+
+    li {
+      margin-bottom: 2.5rem;
+    }
+
+    blockquote {
+      margin: 0;
+      border-left: 8px solid rgba(255, 222, 3, 0.5);
+      padding-left: 1rem;
+    }
+
+    figcaption {
+      margin-left: 1rem;
+    }
+  </style>
+</head>
+<body>
+  <h1><%= @document.title %></h1>
+  <p><%= @document.author %></p>
+
+  <h2>Notes</h2>
+
+  <ul>
+    <% for @note in @document.notes %>
+      <li>
+        <div>
+          <blockquote><p><%= @note.annotation %></p></blockquote>
+          <figcaption><%= @note.type %>: <%= @note.location %></figcaption>
+        </div>
+      </li>
+    <% end %>
+  </ul>
+</body>
+</html>

data/lib/highlights/renderer.rb

@@ -1,24 +1,23 @@
 module Highlights
   class Renderer
+    include Formatter::HTML
+    include Formatter::Markdown
+
     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")
+    def self.render(*args)
+      new(*args).render
+    end
 
-        @document.notes.each do |note|
-          file.puts("> #{note.annotation}")
-          file.write("\n")
-          file.puts("#{note.type}: #{note.location}")
-          file.write("\n")
-        end
+    def render
+      case File.extname(@outfile)
+      when '.md', '.markdown'
+        render_markdown
+      when '.html'
+        render_html
       end
     end
   end

data/lib/highlights/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: highlights
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Graham Marlow
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-22 00:00:00.000000000 Z
+date: 2020-11-26 00:00:00.000000000 Z
 dependencies: []
 description: A CLI tool that converts a Kindle CSV file to markdown.
 email:
@@ -31,6 +31,9 @@ files:
 - lib/highlights.rb
 - lib/highlights/cli.rb
 - lib/highlights/error.rb
+- lib/highlights/formatter/html.rb
+- lib/highlights/formatter/markdown.rb
+- lib/highlights/formatter/template.html.erb
 - lib/highlights/parser.rb
 - lib/highlights/renderer.rb
 - lib/highlights/version.rb