fyodor 0.2.5 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61b605527557fc96f8fbf0d526ee26a157d6dabf4544fbb8d3519197ad0ec45f
-  data.tar.gz: be89647509157f9cab923b498f90b129c3cdb00836e3d8a3c2af5e692252f155
+  metadata.gz: 7caa2b3d167d90c4c640b4069520a102ef82a2745dd133a9c83a24e6c1578eac
+  data.tar.gz: 57f2e8c8353cfd6bae7849bfb031c9a2a1fc24ffae0e4f4aed594c6284c4b8b0
 SHA512:
-  metadata.gz: 8dfc0e521bf352f1c98ac7d7f1203f8cccbd6491a9c216754dbc2ae3072a30361e688f8fe96014719043c3abac866022d7322ae3d5cb155657f434818ac624a1
-  data.tar.gz: 23c025a3c1bbdc206fa1d4cd4bfc6bccdd2e3de2a3735da74482d14c6cd5f74ed14cc834ac0851c5609c8be3aed1637e4312de405fb696594776a0c774731784
+  metadata.gz: 656d7f91ef1091443bd11ad054c0bd638cbc9369205852e9beedf981c836284dd9089898cc738cdd7680cc5c62b7943444252457bac687f43dbc38a1bb3c7026
+  data.tar.gz: 42014ee99f11b258b81987419e7c7529c7514f270c36e76a739997451df3cf0209a0fd2e4746d668b083ff3c8b206228c893db5e93850f7ea53c853fa17a5c3a

data/README.md

@@ -6,9 +6,9 @@ Convert your Amazon Kindle highlights, notes and bookmarks into markdown files.
 
 This application parses `My Clippings.txt` from your Kindle and generates a markdown file for each book/document, in the format `#{Author} - #{Title}.md`. This way, your annotations are conveniently stored and easily managed.
 
-[For samples of the output, click here.](samples/)
+[For samples of the output, click here.](docs/output_demo)
 
-To read more about the motivation and what problem it tries to solve, [check this blog post](http://rafaelc.org/blog/export-all-your-kindle-highlights-and-notes/).
+To read more about the motivation and what problem it tries to solve, [check this blog post](https://rafaelc.org/tech/p/export-all-your-kindle-highlights-and-notes/).
 
 ## Features
 
@@ -22,6 +22,13 @@ To read more about the motivation and what problem it tries to solve, [check thi
 
 This program is based on the clippings file generated by Kindle 2019, but should work with other models.
 
+## Limitations
+
+We are limited by the data Kindle makes available through `My Clippings.txt`. This means:
+
+- We don't have chapter information.
+- We can’t guess all entries that were deleted.
+
 ## Installation
 
 Install Ruby and run:
@@ -40,16 +47,16 @@ $ gem update fyodor
 
 ## Configuration
 
-Fyodor has an optional configuration file, which is used for the following features.
+Fyodor has an optional configuration file, which is used for the following.
 
 ### Languages
 
-If your Kindle is not in English, you should tell Fyodor how some things are called by your `My Clippings.txt` (e.g. highlights, pages, etc). _Note that basic parsing should still work without configuration, but you won't take advantage of many features, resulting in a dirtier output._
+If your Kindle is not in English, you should tell Fyodor how some things are called by your `My Clippings.txt` (e.g. highlights, pages, etc). _Fyodor should still work without configuration, but you won't take advantage of many features, resulting in a dirtier output._
 
-1. Download the sample config to `~/.config/fyodor.toml` or `$XDG_CONFIG_HOME/fyodor.toml`:
+1. Download the sample config to `~/.config/fyodor/fyodor.toml` or `$XDG_CONFIG_HOME/fyodor/fyodor.toml`:
 
-```
-$ wget https://raw.githubusercontent.com/rccavalcanti/fyodor/master/fyodor.toml.sample -O ~/.config/fyodor.toml
+```sh
+$ curl https://raw.githubusercontent.com/rccavalcanti/fyodor/master/docs/fyodor.toml.sample --create-dirs -o ~/.config/fyodor/fyodor.toml
 ```
 
 2. Open both the configuration and your `My Clippings.txt` in your preferred editor. Change the values in the `[parser]` section to mirror what you get in `My Clippings.txt`.
@@ -82,6 +89,18 @@ Where:
 - `CLIPPINGS_FILE` is the path for `My Clippings.txt`.
 - `OUTPUT_DIR` is the directory to write the markdown files. If none is supplied, this will be `fyodor_output` under the current directory.
 
+## PSA: HTML to markdown
+
+Did you export your annotations to HTML using the Kindle mobile app?
+
+You can convert it to markdown with [a script I wrote specifically for it](https://rafaelc.org/k/kindle2md).
+
+## Buy me a coffee
+
+If you like Fyodor, you can show your support here:
+
+<a href="https://rafaelc.org/coffee" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" width="200" ></a>
+
 ## License
 
 Licensed under [GPLv3](LICENSE)

data/bin/fyodor

@@ -1,15 +1,59 @@
 #!/usr/bin/env ruby
 
-require "fyodor/cli"
-
-# Pass --trace to get the stack trace
-if ARGV.include?("--trace")
-  ARGV.delete("--trace")
-  Fyodor::CLI.new.main
-else
-  begin
-    Fyodor::CLI.new.main
-  rescue StandardError => e
-    abort(e.message)
+require "fyodor"
+require "fyodor/config_getter"
+require "fyodor/stats_printer"
+require "fyodor/version"
+require "optimist"
+require "pathname"
+
+module Fyodor
+  class CLI
+    def main
+      parse_args
+      @config = ConfigGetter.new.config
+
+      if @cli_opts.trace
+        run
+      else
+        begin
+          run
+        rescue StandardError => e
+          abort(e.message)
+        end
+      end
+    end
+
+    private
+
+    def get_path(path)
+      Pathname.new(path).expand_path
+    end
+
+    def default_output_dir
+      Pathname.new(Dir.pwd) + "fyodor_output"
+    end
+
+    def run
+      library = Library.new
+      ClippingsParser.new(@clippings_path, @config["parser"]).parse(library)
+      StatsPrinter.new(library).print
+      OutputWriter.new(library, @output_dir, @config["output"]).write_all
+    end
+
+    def parse_args
+      @cli_opts = Optimist::options do
+        version "Fyodor v#{Fyodor::VERSION}"
+        synopsis "Usage: fyodor [options] my_clippings_path [output_dir]"
+
+        opt :trace, "Show backtrace", :default => false
+      end
+
+      Optimist::die "Wrong number of arguments." if ARGV.count != 1 && ARGV.count != 2
+      @clippings_path = get_path(ARGV[0])
+      @output_dir = ARGV[1].nil? ? default_output_dir : get_path(ARGV[1])
+    end
   end
 end
+
+Fyodor::CLI.new.main

data/lib/fyodor/config_getter.rb

@@ -42,8 +42,8 @@ module Fyodor
       return @paths unless @paths.nil?
 
       @paths = []
-      @paths << Pathname.new(ENV["XDG_CONFIG_HOME"]) + "fyodor.toml" unless ENV["XDG_CONFIG_HOME"].nil?
-      @paths << Pathname.new("~/.config/fyodor.toml").expand_path
+      @paths << Pathname.new(ENV["XDG_CONFIG_HOME"]) + "fyodor/fyodor.toml" unless ENV["XDG_CONFIG_HOME"].nil?
+      @paths << Pathname.new("~/.config/fyodor/fyodor.toml").expand_path
     end
 
     def print_path

data/lib/fyodor/entry_parser.rb

@@ -31,9 +31,15 @@ module Fyodor
 
       title, author = @lines[0].scan(regex).first
       # If book has no author, regex fails.
-      title = @lines[0] if title.nil?
+      if title.nil?
+        title = @lines[0]
+        author = ""
+      end
+
+      title = rm_zero_width_chars(title).strip
+      author = rm_zero_width_chars(author).strip
 
-      {title: title.strip, author: author.to_s.strip}
+      {title: title, author: author}
     end
 
     def desc
@@ -93,5 +99,9 @@ module Fyodor
       raise "Entry is badly formatted" if @lines[1].strip.empty?
       raise "Entry is badly formatted" unless @lines[2].strip.empty?
     end
+
+    def rm_zero_width_chars(str)
+      str.gsub(/[\u200B-\u200D\uFEFF]/, '')
+    end
   end
 end

data/lib/fyodor/version.rb

@@ -1,3 +1,3 @@
 module Fyodor
-  VERSION = "0.2.5".freeze
+  VERSION = "0.2.9".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fyodor
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.9
 platform: ruby
 authors:
 - Rafael Cavalcanti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Parse Kindle clippings into markdown files
 email: code@rafaelc.org
 executables:
@@ -36,7 +50,6 @@ files:
 - bin/fyodor
 - lib/fyodor.rb
 - lib/fyodor/book.rb
-- lib/fyodor/cli.rb
 - lib/fyodor/clippings_parser.rb
 - lib/fyodor/config_getter.rb
 - lib/fyodor/core_extensions/hash/merging.rb
@@ -62,6 +75,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/fyodor/cli.rb

@@ -1,42 +0,0 @@
-require "fyodor/config_getter"
-require "fyodor/stats_printer"
-require "fyodor/library"
-require "fyodor/clippings_parser"
-require "fyodor/output_writer"
-require "pathname"
-
-module Fyodor
-  class CLI
-    USAGE = "Usage: #{File.basename($0)} my_clippings_path [output_dir]"
-
-    def initialize
-      get_args
-      @config = ConfigGetter.new.config
-    end
-
-    def main
-      library = Library.new
-      ClippingsParser.new(@clippings_path, @config["parser"]).parse(library)
-      StatsPrinter.new(library).print
-      OutputWriter.new(library, @output_dir, @config["output"]).write_all
-    end
-
-
-    private
-
-    def get_args
-      abort(USAGE) if ARGV.count != 1 && ARGV.count != 2
-
-      @clippings_path = get_path(ARGV[0])
-      @output_dir = ARGV[1].nil? ? default_output_dir : get_path(ARGV[1])
-    end
-
-    def get_path(path)
-      Pathname.new(path).expand_path
-    end
-
-    def default_output_dir
-      Pathname.new(Dir.pwd) + "fyodor_output"
-    end
-  end
-end